Carbon


DumpControlHierarchy

Header: Controls.h Carbon status: Supported

Writes a textual representation of the control hierarchy for a specified window into a file.

OSErr DumpControlHierarchy (
    WindowRef inWindow, 
    const FSSpec *inDumpFile
);
inWindow

A pointer to the window whose control hierarchy you wish to examine.

inDumpFile

A pointer to a file specification in which to place a text description of the window’s control hierarchy.

function result

A result code.

DISCUSSION

The DumpControlHierarchy function places a text listing of the current control hierarchy for the window specified into the specified file, overwriting any existing file. If the specified window does not contain a control hierarchy, DumpControlHierarchy notes this in the text file. This function is useful for debugging embedding-related problems.

VERSION NOTES

This function is available with Appearance Manager 1.0 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)